<!DOCTYPE html>
<html lang="en">
<head>

  <meta charset="utf-8">
  <meta name="viewport" content="width=device-width, initial-scale=1.0">

  <title>
      yoctore/yocto-doc - Documentation
  </title>

  <link href="https://www.braintreepayments.com/images/favicon-ccda0b14.png" rel="icon" type="image/png">

  <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.7.0/highlight.min.js"></script>
  <script>hljs.initHighlightingOnLoad();</script>

  <script src="https://ajax.googleapis.com/ajax/libs/jquery/3.1.0/jquery.min.js"></script>

  <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
  <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">

  

  
  <script type="text/javascript" src="scripts/lodash.min.js"></script>
  <script type="text/javascript" src="scripts/search.js"></script>
  <link type="text/css" rel="stylesheet" href="styles/custom.css"/>
</head>

<body>
  <svg style="display: none;">
    <defs>
      <symbol id="linkIcon" fill="#706d77" height="24" viewBox="0 0 24 24" width="24" xmlns="http://www.w3.org/2000/svg">
          <path d="M0 0h24v24H0z" fill="none"/>
          <path d="M3.9 12c0-1.71 1.39-3.1 3.1-3.1h4V7H7c-2.76 0-5 2.24-5 5s2.24 5 5 5h4v-1.9H7c-1.71 0-3.1-1.39-3.1-3.1zM8 13h8v-2H8v2zm9-6h-4v1.9h4c1.71 0 3.1 1.39 3.1 3.1s-1.39 3.1-3.1 3.1h-4V17h4c2.76 0 5-2.24 5-5s-2.24-5-5-5z"/>
      </symbol>
    </defs>
  </svg>

  <input type="checkbox" id="nav-trigger" class="nav-trigger" />
  <label for="nav-trigger" class="navicon-button x">
    <div class="navicon"></div>
  </label>

  <label for="nav-trigger" class="overlay"></label>

  <div class="top-nav-wrapper">
    <ul>
      <li >
        <a href="index.html">
          
            <svg fill="#6D6D6D" height="24" viewBox="0 0 24 24" width="24" xmlns="http://www.w3.org/2000/svg">
              <path d="M10 20v-6h4v6h5v-8h3L12 3 2 12h3v8z"/>
              <path d="M0 0h24v24H0z" fill="none"/>
            </svg>
          
          
        </a>
      </li>

      

    </ul>
  </div>

  <nav>
    <h3 class="reference-title">
      yocto-doc<br/>Version <span style='color:#0095dd'>v2.3.7</span>
    </h3>

    <h3>Modules</h3><ul><li id="yoctore_yocto-doc-nav"><a href="module-yoctore_yocto-doc.html">yoctore/yocto-doc</a></li></ul>
  </nav>

  <div id="main">
    
      <h1 class="page-title">
        yoctore/yocto-doc
      </h1>
    

    

<section>
  <header>
    
      
        
  </header>

  <article>
    <div class="container-overview">
      
        
          <div class="description">
            <p>This module is a grunt task to generate automatic documentation for a javascript project</p>
<p>This module is based on <b><a class="blank" href="http://usejsdoc.org/">jsdoc</a></b> for language syntax
and on <b><a class="blank" href="https://github.com/braintree/jsdoc-template">Braintree JSDoc Template</a></b> for templating.</p>
<p>To use it just setup your <code class="code">Gruntfile.js</code> file with this example and change needed property.</p>
          </div>
        

        
          













<dl class="details">

  

  

  

  

  

  

  

  

  

  

  

  

  
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source">
      <ul class="dummy">
        <li>
          <a href="yoctodoc.js.html">yoctodoc.js</a>, <a href="yoctodoc.js.html#line11">line 11</a>
        </li>
      </ul>
    </dd>
  

  

  

  
</dl>













  <div class="example-container">
    <a class="link-icon" href="#yoctore/yocto-doc-examples">
      <svg height="20" width="20" style="fill: black;">
        <use xlink:href="#linkIcon"></use>
      </svg>
    </a>
    <h5 id="yoctore/yocto-doc-examples">Example</h5>
    

  <pre class="prettyprint"><code>module.exports = function (grunt) {

grunt.initConfig({
 // default package
 pkg       : grunt.file.readJSON('package.json'),
 // Define yocto doc config
 yoctodoc  : {
   options : {
     destination     : './docs',
     copyExtraFiles  : [ 'assets/*.png' ]
   },
  all     : [ 'tasks/yoctodoc.js' ]
 }
});

// Register Task
grunt.registerTask('doc', [ 'yoctodoc' ]);</code></pre>


  </div>


        
      
    </div>

    

    

    

     

    

    

    

    

    
  </article>
</section>




  </div>

  <br class="clear">

  <footer>Documentation for application <b>yocto-doc<b>.<br/>Generated at Wed Sep 26 2018 11:24:10 GMT+0400 (+04) with <a href='https://www.npmjs.com/package/yoctodoc'>yocto-doc</a><br/>Copyright Yocto © 2014 - 2018</footer>

  <script src="scripts/linenumber.js"></script>
  <script src="scripts/pagelocation.js"></script>

  
  
</body>
</html>